API actions

In addition to object-based operations, the AtomSphere API supports action-based operations that do not fall into the object/verb hierarchy.

Boomi supports the following action-based operations:

info

To import these operations, you must select the EXECUTE connector action in the AtomSphere API and Partner API connectors. The Upgrade Java operation is not available for importing.

info

Integration-specific AtomSphere API and Partner REST APIs are also available from the OpenAPI 3.0 specification. Because OpenAPI 3.0 is language agnostic, it enables users to easily discover available Integration API and Partner API objects and actions, test requests and responses, and understand the API's functionality. For more information, see the topic OpenAPI 3.0.

• Add Plans to Deployments

• Remove Plans from Deployments

• Send Changes to Authentication Source

• Cancel execution — cancel a process run that is currently running on a particular runtime.

• Change listener status — pause, resume, or restart listeners

• Clear queue messages — clear all messages for a given Atom queue.

• Connector document — retrieve a list of connector document data for a given process run.

• Deploy component — (Legacy deployment, Deprecated) copy a component deployment from one environment to another.

• Deploy process — (Legacy deployment, Deprecated) copy a process deployment from one environment to another.

• Download AS2 artifacts log — asynchronously download the AS2 artifacts log for a particular runtime for a particular date.

• Download runtime log — asynchronously download the runtime log for a particular runtime for a particular date.

• Download execution worker log — asynchronously download logs for a particular execution worker.

• Download execution artifacts — asynchronously download run artifacts for a particular process.

• Download process log — asynchronously download log(s) for a particular process run.

• Download shared web server log — asynchronously download the shared web server logs for a particular runtime for a particular date.

• Execute process — asynchronously run a process on a particular runtime.

• Get assignable roles — retrieve the list of roles assignable under an Platform account.

• List queues — retrieve the list of queues associated with a given account.

• Move queue request — move messages from one Atom queue to another.

• Provision partner customer account — provision a partner customer account with specified features as a subordinate account of the partner account.

• Purge runtime data — initiate the purge process for runtime data, like browse components and logs.

• Rerun document — rerun one or more documents.

• Roll back Java — roll back a runtime or API Management runtime to use its previous version of Java.

• Upgrade Java — upgrade a given container (basic runtime, runtime cluster, runtime cloud, Authentication Broker, or API Gateway, or ) to Boomi's latest supported version of Java.